<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - SztakipediaClient</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

#header
{
	clear: both;
	background-color: white;
	padding: 8px;
	border-bottom: 8px solid #ccc;
	display: block;
	width: 100%;
	line-height: 1.5em;
}

#banner
{
	margin-bottom: 1em;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}

		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
	<div id="banner">
		<a href="http://pedia.sztaki.hu" target="_blank" title="Sztakipedia project"><img src="http://pedia.sztaki.hu/img/sztakilogo.png" alt="Sztakipedia project banner"/></a>
	</div>
	<span style="font-size: 130%;"><a href="http://code.google.com/p/sztakipedia-toolbar/" target="_blank">Sztakipedia toolbar</a> source code documentation</span><br />
	Part of <a href="http://pedia.sztaki.hu/" target="_blank">Sztakipedia project</a> at
	<a href="http://sztaki.hu/" target="_blank">MTA SZTAKI</a>
</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/SztakipediaClient.html">SztakipediaClient</a></li>
	
	<li><a href="../symbols/SztakipediaTB.html">SztakipediaTB</a></li>
	
	<li><a href="../symbols/sztakipediaTemplate.html">sztakipediaTemplate</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace SztakipediaClient
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				Offers convenient interface to the Sztakipedia REST API services.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_SztakipediaClient.js.html">SztakipediaClient.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class SztakipediaClient.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/SztakipediaClient.html#constructor">SztakipediaClient</a></b>
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class SztakipediaClient.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.DefaultOptions">DefaultOptions</a></b>
								</div>
								<div class="description">Default options - these mainly exist so the script won't break when a new option is added.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class SztakipediaClient.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.answerDialog">answerDialog</a></b>(callback, token, builder, dialogId, suggestionId)
								</div>
								<div class="description">Signal that the user accepted a suggestion towards the remote REST API.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.buildDialogs">buildDialogs</a></b>(callback, token, dialogbuilder, builderparams)
								</div>
								<div class="description">Request suggestions from the given dialog builders through remote REST API.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.buildList">buildList</a></b>(callback, token, processor)
								</div>
								<div class="description">Request entities from the given text processor through remote REST API.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.doGet">doGet</a></b>(params, callback)
								</div>
								<div class="description">Perform a GET request to the API endpoint.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.extractTextNonRecursive">extractTextNonRecursive</a></b>(elem)
								</div>
								<div class="description">Concatenate text nodes inside the element, up to immediate child elements.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.extractTextRecursive">extractTextRecursive</a></b>(elem)
								</div>
								<div class="description">Concatenate text nodes inside the element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.getOption">getOption</a></b>(opt)
								</div>
								<div class="description">Get an option - user settings override global which override defaults</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.htmlAttributesAsHash">htmlAttributesAsHash</a></b>(elem)
								</div>
								<div class="description">Read an HTML elements attribute list into a hash.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.init">init</a></b>()
								</div>
								<div class="description">Perform one-time initialization.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.newSession">newSession</a></b>(callback)
								</div>
								<div class="description">Start new session.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.newToken">newToken</a></b>(callback)
								</div>
								<div class="description">Request a new token for submitting a wikitext fragment.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.parseDialog">parseDialog</a></b>(xml)
								</div>
								<div class="description">Retrieve the list of dialogs from the response DOM element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.parseDialogBuilders">parseDialogBuilders</a></b>(xml)
								</div>
								<div class="description">Retrieve the list of available dialog builders from the response DOM element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.parseProcessors">parseProcessors</a></b>(xml)
								</div>
								<div class="description">Retrieve the list of available processors from the response DOM element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.parseSessionId">parseSessionId</a></b>(xml)
								</div>
								<div class="description">Retrieve the session ID from the response DOM element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.parseToken">parseToken</a></b>(xml)
								</div>
								<div class="description">Retrieve the token from the response DOM element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.parseXML">parseXML</a></b>(data)
								</div>
								<div class="description">Uses the native parsing function of the browser to create a valid XML Document.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.queryDialogBuilders">queryDialogBuilders</a></b>(callback)
								</div>
								<div class="description">Retrieve available dialog builders through remote REST API.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.queryProcessors">queryProcessors</a></b>(callback)
								</div>
								<div class="description">Retrieve available processors through remote REST API.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.queryUrl">queryUrl</a></b>(params)
								</div>
								<div class="description">Assemble a query URL from a set of parameters.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.serializeXML">serializeXML</a></b>(elem)
								</div>
								<div class="description">Get the string representation of a DOM XML node.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.update">update</a></b>(callback, token, content, inputformat)
								</div>
								<div class="description">Replace remotely stored wikitext associated with the given token.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">SztakipediaClient.<b><a href="../symbols/SztakipediaClient.html#.xmlAttributesAsHash">xmlAttributesAsHash</a></b>(elem)
								</div>
								<div class="description">Read an XML elements attribute list into a hash.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>SztakipediaClient</b>
				</div>
				
				<div class="description">
					
					
				</div>
				
				
				
				
					
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">Requires:</dt>
						
							<dd>jQuery</dd>
						
						</dl>
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name=".DefaultOptions"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Object}</span>
					<span class="light">SztakipediaClient.</span><b>DefaultOptions</b>
					
					</div>
					<div class="description">
						Default options - these mainly exist so the script won't break when a new option is added.
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".answerDialog"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>answerDialog</b>(callback, token, builder, dialogId, suggestionId)
					
					</div>
					<div class="description">
						Signal that the user accepted a suggestion towards the remote REST API.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with nothing.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>token</b>
									
								</dt>
								<dd>The token of the wikitext to be processed.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>builder</b>
									
								</dt>
								<dd>The unique name of the builder.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>dialogId</b>
									
								</dt>
								<dd>The identifier of the dialog.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>suggestionId</b>
									
								</dt>
								<dd>The identifier of the suggestion being accepted.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".buildDialogs"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>buildDialogs</b>(callback, token, dialogbuilder, builderparams)
					
					</div>
					<div class="description">
						Request suggestions from the given dialog builders through remote REST API.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function(Object)|function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with the resulting array of dialogs.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>token</b>
									
								</dt>
								<dd>The token of the wikitext to be processed.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>dialogbuilder</b>
									
								</dt>
								<dd>The unique name of the dialog builder.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>builderparams</b>
									<i>Optional</i>
								</dt>
								<dd>The unique name of the dialog builder.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".buildList"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>buildList</b>(callback, token, processor)
					
					</div>
					<div class="description">
						Request entities from the given text processor through remote REST API.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function(Object)|function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with the resulting array of entities.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>token</b>
									
								</dt>
								<dd>The token of the wikitext to be processed.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>processor</b>
									
								</dt>
								<dd>The unique name of the processor.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Deprecated:</dt>
							<dt>
								Response processing not implemented.
							</dt>
							</dl>
						
						
						
						
						
						

					<hr />
				
					<a name=".doGet"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>doGet</b>(params, callback)
					
					</div>
					<div class="description">
						Perform a GET request to the API endpoint.

For JSONP requests, the API response always returns a HTTP 200 OK status, while indicating actual status code (and probably error message) in the payload as follows.
For successful requests:
<blockquote>
<code>json123(['...content...', 200])</code>
</blockquote>
For unsuccessful requests:
<blockquote>
<code>json123([null, 5xx, '...error...'])</code>
</blockquote>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>params</b>
									
								</dt>
								<dd>The HTTP request parameters to be passed.</dd>
							
								<dt>
									<span class="light fixedFont">{function((string|undefined))}</span> <b>callback</b>
									<i>Optional</i>
								</dt>
								<dd>The function to be called with the HTTP response content String, or undefined on failure.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".extractTextNonRecursive"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>extractTextNonRecursive</b>(elem)
					
					</div>
					<div class="description">
						Concatenate text nodes inside the element, up to immediate child elements.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Node}</span> <b>elem</b>
									
								</dt>
								<dd>The DOM element.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".extractTextRecursive"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>extractTextRecursive</b>(elem)
					
					</div>
					<div class="description">
						Concatenate text nodes inside the element.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Node}</span> <b>elem</b>
									
								</dt>
								<dd>The DOM element.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getOption"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>getOption</b>(opt)
					
					</div>
					<div class="description">
						Get an option - user settings override global which override defaults
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>opt</b>
									
								</dt>
								<dd>The name of the option.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string The value of the option.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".htmlAttributesAsHash"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>htmlAttributesAsHash</b>(elem)
					
					</div>
					<div class="description">
						Read an HTML elements attribute list into a hash.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Node}</span> <b>elem</b>
									
								</dt>
								<dd>The DOM element.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".init"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>init</b>()
					
					</div>
					<div class="description">
						Perform one-time initialization.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name=".newSession"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>newSession</b>(callback)
					
					</div>
					<div class="description">
						Start new session.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function(string)|function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with the resulting session ID.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".newToken"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>newToken</b>(callback)
					
					</div>
					<div class="description">
						Request a new token for submitting a wikitext fragment.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function(string)|function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with the resulting token.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".parseDialog"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>parseDialog</b>(xml)
					
					</div>
					<div class="description">
						Retrieve the list of dialogs from the response DOM element.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>xml</b>
									
								</dt>
								<dd>The XML DOM element to be processed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object List of dialogs.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".parseDialogBuilders"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>parseDialogBuilders</b>(xml)
					
					</div>
					<div class="description">
						Retrieve the list of available dialog builders from the response DOM element.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>xml</b>
									
								</dt>
								<dd>The XML DOM element to be processed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object List of available dialog builders.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".parseProcessors"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>parseProcessors</b>(xml)
					
					</div>
					<div class="description">
						Retrieve the list of available processors from the response DOM element.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>xml</b>
									
								</dt>
								<dd>The XML DOM element to be processed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object List of available processors.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".parseSessionId"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>parseSessionId</b>(xml)
					
					</div>
					<div class="description">
						Retrieve the session ID from the response DOM element.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>xml</b>
									
								</dt>
								<dd>The XML DOM element to be processed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string The session ID.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".parseToken"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>parseToken</b>(xml)
					
					</div>
					<div class="description">
						Retrieve the token from the response DOM element.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>xml</b>
									
								</dt>
								<dd>The XML DOM element to be processed.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string The token.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".parseXML"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>parseXML</b>(data)
					
					</div>
					<div class="description">
						Uses the native parsing function of the browser to create a valid XML Document.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>data</b>
									
								</dt>
								<dd>{string} the XML as a string</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object the XML DOM, or <code>undefined</code> if <code>data</code> is <code>undefined</code></dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".queryDialogBuilders"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>queryDialogBuilders</b>(callback)
					
					</div>
					<div class="description">
						Retrieve available dialog builders through remote REST API.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function(Object)|function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with the resulting array.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".queryProcessors"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>queryProcessors</b>(callback)
					
					</div>
					<div class="description">
						Retrieve available processors through remote REST API.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function(Object)|function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with the resulting array.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".queryUrl"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>queryUrl</b>(params)
					
					</div>
					<div class="description">
						Assemble a query URL from a set of parameters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>params</b>
									
								</dt>
								<dd>A key-value map of the HTTP parameters.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>string The URL to query the remote REST API.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".serializeXML"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>serializeXML</b>(elem)
					
					</div>
					<div class="description">
						Get the string representation of a DOM XML node.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Node}</span> <b>elem</b>
									
								</dt>
								<dd>The DOM element.</dd>
							
							</dl>
						
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd>adapted from http://forum.jquery.com/topic/jquery-serializing-xml#14737000000169757</dd>
							
							</dl>
						

					<hr />
				
					<a name=".update"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>update</b>(callback, token, content, inputformat)
					
					</div>
					<div class="description">
						Replace remotely stored wikitext associated with the given token.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function()}</span> <b>callback</b>
									
								</dt>
								<dd>The function to be called with nothing.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>token</b>
									
								</dt>
								<dd>The token of the wikitext to be updated.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>content</b>
									
								</dt>
								<dd>The new wikitext.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>inputformat</b>
									<i>Optional</i>
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".xmlAttributesAsHash"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">SztakipediaClient.</span><b>xmlAttributesAsHash</b>(elem)
					
					</div>
					<div class="description">
						Read an XML elements attribute list into a hash.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Node}</span> <b>elem</b>
									
								</dt>
								<dd>The DOM element.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Object</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy; 2011 - MTA SZTAKI <br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0
		</div>
	</body>
</html>
